<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FreeRTOS Addons: cpp_freertos::BinarySemaphore Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">FreeRTOS Addons
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespacecpp__freertos.html">cpp_freertos</a></li><li class="navelem"><a class="el" href="classcpp__freertos_1_1_binary_semaphore.html">BinarySemaphore</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classcpp__freertos_1_1_binary_semaphore-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">cpp_freertos::BinarySemaphore Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="semaphore_8hpp_source.html">semaphore.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for cpp_freertos::BinarySemaphore:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classcpp__freertos_1_1_binary_semaphore.png" usemap="#cpp_5Ffreertos::BinarySemaphore_map" alt=""/>
  <map id="cpp_5Ffreertos::BinarySemaphore_map" name="cpp_5Ffreertos::BinarySemaphore_map">
<area href="classcpp__freertos_1_1_semaphore.html" alt="cpp_freertos::Semaphore" shape="rect" coords="0,0,191,24"/>
  </map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a852811f96c09920dbb2bd06bcc2c2928"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__freertos_1_1_binary_semaphore.html#a852811f96c09920dbb2bd06bcc2c2928">BinarySemaphore</a> (bool set=false)</td></tr>
<tr class="separator:a852811f96c09920dbb2bd06bcc2c2928"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classcpp__freertos_1_1_semaphore"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classcpp__freertos_1_1_semaphore')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classcpp__freertos_1_1_semaphore.html">cpp_freertos::Semaphore</a></td></tr>
<tr class="memitem:a633658a6fde276bffc912028725c6ade inherit pub_methods_classcpp__freertos_1_1_semaphore"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__freertos_1_1_semaphore.html#a633658a6fde276bffc912028725c6ade">~Semaphore</a> ()</td></tr>
<tr class="separator:a633658a6fde276bffc912028725c6ade inherit pub_methods_classcpp__freertos_1_1_semaphore"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2328f019955e0f2e94d72b26d71bf76 inherit pub_methods_classcpp__freertos_1_1_semaphore"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__freertos_1_1_semaphore.html#ae2328f019955e0f2e94d72b26d71bf76">Give</a> ()</td></tr>
<tr class="separator:ae2328f019955e0f2e94d72b26d71bf76 inherit pub_methods_classcpp__freertos_1_1_semaphore"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a48c0998ba13e32110b2738651b9b07d5 inherit pub_methods_classcpp__freertos_1_1_semaphore"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__freertos_1_1_semaphore.html#a48c0998ba13e32110b2738651b9b07d5">GiveFromISR</a> (BaseType_t *pxHigherPriorityTaskWoken)</td></tr>
<tr class="separator:a48c0998ba13e32110b2738651b9b07d5 inherit pub_methods_classcpp__freertos_1_1_semaphore"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af5fa43c906669b93af48de68f72ca8de inherit pub_methods_classcpp__freertos_1_1_semaphore"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__freertos_1_1_semaphore.html#af5fa43c906669b93af48de68f72ca8de">Take</a> (TickType_t Timeout=portMAX_DELAY)</td></tr>
<tr class="separator:af5fa43c906669b93af48de68f72ca8de inherit pub_methods_classcpp__freertos_1_1_semaphore"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8f8ce6e3fa6704572c29f672d8d2db6 inherit pub_methods_classcpp__freertos_1_1_semaphore"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__freertos_1_1_semaphore.html#aa8f8ce6e3fa6704572c29f672d8d2db6">TakeFromISR</a> (BaseType_t *pxHigherPriorityTaskWoken)</td></tr>
<tr class="separator:aa8f8ce6e3fa6704572c29f672d8d2db6 inherit pub_methods_classcpp__freertos_1_1_semaphore"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classcpp__freertos_1_1_semaphore"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classcpp__freertos_1_1_semaphore')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classcpp__freertos_1_1_semaphore.html">cpp_freertos::Semaphore</a></td></tr>
<tr class="memitem:ae32c955336ae9e60e20a3facde270714 inherit pro_methods_classcpp__freertos_1_1_semaphore"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__freertos_1_1_semaphore.html#ae32c955336ae9e60e20a3facde270714">Semaphore</a> ()</td></tr>
<tr class="separator:ae32c955336ae9e60e20a3facde270714 inherit pro_methods_classcpp__freertos_1_1_semaphore"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_classcpp__freertos_1_1_semaphore"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classcpp__freertos_1_1_semaphore')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classcpp__freertos_1_1_semaphore.html">cpp_freertos::Semaphore</a></td></tr>
<tr class="memitem:a524cc7b70300cd28d223bfdf9034c09f inherit pro_attribs_classcpp__freertos_1_1_semaphore"><td class="memItemLeft" align="right" valign="top">SemaphoreHandle_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__freertos_1_1_semaphore.html#a524cc7b70300cd28d223bfdf9034c09f">handle</a></td></tr>
<tr class="separator:a524cc7b70300cd28d223bfdf9034c09f inherit pro_attribs_classcpp__freertos_1_1_semaphore"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Wrapper class for Binary Semaphores. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a852811f96c09920dbb2bd06bcc2c2928" name="a852811f96c09920dbb2bd06bcc2c2928"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a852811f96c09920dbb2bd06bcc2c2928">&#9670;&#160;</a></span>BinarySemaphore()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">BinarySemaphore::BinarySemaphore </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>set</em> = <code>false</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p >Constructor to create a binary semaphore.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">set</td><td>Is this semaphore "full" or not? </td></tr>
  </table>
  </dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname"><a class="el" href="classcpp__freertos_1_1_semaphore_create_exception.html">SemaphoreCreateException</a></td><td>on failure. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Instance of a <a class="el" href="classcpp__freertos_1_1_binary_semaphore.html">BinarySemaphore</a>. </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/<a class="el" href="semaphore_8hpp_source.html">semaphore.hpp</a></li>
<li>src/freertos-addon/c++/csemaphore.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
</small></address>
</body>
</html>
